"""
Copyright 2009 Texas A&M University
 
Licensed under the Apache License, Version 2.0 (the "License"); you may not use 
this file except in compliance with the License. You may obtain a copy of the 
License at

http://www.apache.org/licenses/LICENSE-2.0
  
Unless required by applicable law or agreed to in writing, software distributed 
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR 
CONDITIONS OF ANY KIND, either express or implied. See the License for the 
specific language governing permissions and limitations under the License. 
"""

from meercat.job.interfaces import IJob



class ISolrJob(IJob):
    def getIdentifierField(self):
        """ Return the name of the field used as the primary identifier in SOLR """
    
    def getSolrConnection(self):
        """ Return a thread local SOLR connection """
    
    def getStorage(self):
        """ Return the storage used for the SOLR job """

class ISolrPushJob(ISolrJob):
    def getMapReduceArguments(self):
        """ Return a dictionary that can be passed to the 
        mapReduce function as keyword arguments. """

class ISolrDedupeJob(ISolrJob):
    def getIdentifierFields(self):
        """ Return a list of solr fields to use for deduping """
